home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / onlin16.zip / ONLINE.DOC < prev    next >
Text File  |  1993-03-21  |  18KB  |  471 lines
  1.  
  2.  
  3.                        ============================
  4.                                  OnLine!
  5.                        ============================
  6.                          (c)1992,93 T&J Software
  7.  
  8.         One of the T&J Software Collection of multi-BBS door programs.
  9.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  10.               UltraBBS, Telegard, TriBBS, Remote Access, and WWIV
  11.  
  12.                        VERSION 1.60     03/20/93
  13.  
  14.                                    By
  15.  
  16.                                Tom Wildoner
  17.                              397 West Broadway
  18.                               Jim Thorpe, PA
  19.                                   18229
  20.                             VOICE (717)325-9480
  21.                    *between 5:30 & 10:00 p.m. Eastern Time
  22.  
  23.                                   From
  24.  
  25.                            The T&J Software BBS
  26.                               (717)325-9481
  27.                            1200/2400/9600/19200
  28.                                24 Hours/Day
  29.  
  30. LATEST VERSION:
  31. ===============
  32.  
  33. Please call the T&J Software BBS for the latest version of this program.
  34. We always try to keep an ample supply of the latest text files of
  35. interest for you to include in your copy of OnLine!
  36.  
  37.  
  38. LEGALITIES:
  39. ===========
  40.  
  41. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  42. WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY
  43. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  44. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS
  45. PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING
  46. OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  47.  
  48.  
  49. DISTRIBUTION:
  50. =============
  51.  
  52. You may make this file available for downloading from your BBS or you may
  53. upload it to any BBS of your choice, provided that you do not make any
  54. changes to the contents of the archive (ZIP file). The archive and its
  55. individual contents may not be used by any service that charges any money
  56. whatsoever, without the written permission of the author.
  57.  
  58.  
  59. PROGRAM DESCRIPTION:
  60. ====================
  61.  
  62. OnLine! is basically a way for you, the SysOp, to setup your own online
  63. type of magazine or your own online text search door. You can make your
  64. own Hello and Goodbye screens, and you can have up to 1600 articles/ANSI
  65. screens for your users to read/search online and have them broken down
  66. into 40 different sub-menus.
  67.  
  68. OnLine also supports downloading of articles/ansi screens right from
  69. within the door itself. Users may download using X, Y, or ZModem
  70. transfer protocols. You have the option to turn the downloading flag
  71. ON or OFF when you add an article to the database using OLSETUP.
  72. Speaking of downloading, OLSETUP also allows you to turn GLOBAL
  73. downloading on or off also! OnLine will also prompt the user if he/she
  74. would like the file Zipped prior to transferring the file!
  75.  
  76. Think of OnLine as a "shell" for you to build on. You can customize it
  77. to your favorite colors, text files, ANSI screens etc.
  78.  
  79. When viewing TEXT files, you may SEARCH the text file for a KEYWORD,
  80. goto the next page (like PAGE DOWN), and goto the previous page (like
  81. PAGE UP).
  82.  
  83. OnLine also has HELP available right from the main menu of the door
  84. and the ability to generate STATISTICS on its usage. Statistics
  85. generation is user prompted by selecting 'S' from the main menu.
  86.  
  87. ANSI files simply display to the user and then return to the main menu.
  88. There is no way to "search" an ANSI file.
  89.  
  90.  
  91. NOTE:
  92. =====
  93.  
  94. The ONLINE.KEY file that is distributed with this door does NOT expire!
  95. This is simply here so the door has a KEY to read. When you register,
  96. you will receive a new ONLINE.KEY file.
  97.  
  98. You may only display/use 2 sub-menus with 2 articles in each until
  99. the door is registered. After you register, the limit is 1600 articles
  100. or ANSI screens, and all future upgrades to the door are free.
  101.  
  102. FEATURES:
  103. =========
  104.            --- Desqview/Network Aware.
  105.            --- COM0-15 support and non-standard IRQ's.
  106.            --- Colorful ANSI screens.
  107.            --- Chat function.
  108.            --- NO BRUN module needed for play.
  109.            --- BETA tested on many different boards.
  110.            --- Will return to BBS on dropped carrier.
  111.            --- Will TIMEOUT a player after 5 minutes of no activity.
  112.            --- Use of HOT KEYS while in the door.
  113.            --- Support BBS available.
  114.            --- 40 Sub-Menus.
  115.            --- 1,600 Total Articles.
  116.            --- Downloading Option using X, Y, or ZModem.
  117.            --- Fossil Driver support.
  118.            --- Online HELP and STATISTICS available.
  119.            --- Page Forward or Back.
  120.            --- KEYWORD Searching.
  121.  
  122.  
  123. UPGRADING:
  124. ==========
  125.  
  126. See the file OLSETUP.DOC for information on UPGRADING from v1.5 to
  127. this version of the door. OLSETUP will take care of the upgrading but
  128. refer to the OLSETUP.DOC file prior to attempting it.
  129.  
  130.  
  131. INSTALLATION: (using the OLSETUP.EXE file)
  132. ===============================================
  133.  
  134. Please refer to the documentation on OLSETUP contained in the file:
  135. OLSETUP.DOC
  136.  
  137. We've decided to move the setup program outside the main code. Most
  138. updates of the door (in the past) was the setup program. This will
  139. allow us to modify/edit the OLSETUP.EXE without disturbing the door
  140. itself.
  141.  
  142.  
  143. ERROR.LOG FILE:
  144. ===============
  145.  
  146. OnLine! and OLSETUP will both write to a file called ERROR.LOG. There
  147. is a seperate section in the OLSETUP.DOC listing how OLSETUP deals
  148. with this file.
  149.  
  150. OnLine! will write to this file if any of the following happens:
  151.  
  152.         - A user tries reading a file that doesn't exist on your
  153.           hard drive. In the old version, this would have been enough
  154.           to crash your system. This version of the door no checks
  155.           for the files existence prior to trying to open it. If
  156.           the file is not found, it will tell you the filename that
  157.           wasn't found and where it should be placed.
  158.  
  159.         - A user tries viewing the STATISTICS, but the file was
  160.           not found on the disk.
  161.  
  162. All other types of errors will be listed in a file called DFRAME.ERR.
  163.  
  164.  
  165. CONFIGURATION:
  166. =============
  167.  
  168. Example configuration file for PCBOARD.SYS
  169. ------------------------------------------
  170.  
  171. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  172. T&J Software        <=-  (Change this to your BBS name)
  173. Tom                 <=-  (The Sysop's first name)
  174. Wildoner            <=-  (The Sysop's last name)
  175.  
  176. Example configuration file for USERS.SYS
  177. ----------------------------------------
  178.  
  179. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  180. T&J Software        <=-  (Change this to your BBS name)
  181. Tom                 <=-  (The Sysop's first name)
  182. Wildoner            <=-  (The Sysop's last name)
  183.  
  184. Example configuration file for DOOR.SYS
  185. ---------------------------------------
  186.  
  187. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  188. T&J Software        <=-  (Change this to your BBS name)
  189. Tom                 <=-  (The Sysop's first name)
  190. Wildoner            <=-  (The Sysop's last name)
  191.  
  192. Example configuration file for USERINFO.DAT
  193. -------------------------------------------
  194.  
  195. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  196. T&J Software        <=-  (Change this to your BBS name)
  197. Tom                 <=-  (The Sysop's first name)
  198. Wildoner            <=-  (The Sysop's last name)
  199. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  200.  
  201. Example configuration file for CALLINFO.BBS
  202. -------------------------------------------
  203.  
  204. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  205. T&J Software        <=-  (Change this to your BBS name)
  206. Tom                 <=-  (The Sysop's first name)
  207. Wildoner            <=-  (The Sysop's last name)
  208.  
  209. Example configuration file for DORINFOx.DEF
  210. -------------------------------------------
  211.  
  212. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  213.                           where 'x' is the BBS Node number.
  214. T&J Software        <=-  (Change this to your BBS name)
  215. Tom                 <=-  (The Sysop's first name)
  216. Wildoner            <=-  (The Sysop's last name)
  217.  
  218. Example configuration file for SFDOORS.DAT
  219. ------------------------------------------
  220.  
  221. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  222. T&J Software        <=-  (Change this to your BBS name)
  223. Tom                 <=-  (The Sysop's first name)
  224. Wildoner            <=-  (The Sysop's last name)
  225.  
  226. Example configuration file for CHAIN.TXT
  227. ----------------------------------------
  228.  
  229. C:\BBS\CHAIN.TXT    <=-  (Full pathname of your CHAIN.TXT file)
  230. T&J Software        <=-  (Change this to your BBS name)
  231. Tom                 <=-  (The Sysop's first name)
  232. Wildoner            <=-  (The Sysop's last name)
  233.  
  234. Example configuration file for GTUSER.BBS
  235. -----------------------------------------
  236.  
  237. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  238. T&J Software        <=-  (Change this to your BBS name)
  239. Tom                 <=-  (The Sysop's first name)
  240. Wildoner            <=-  (The Sysop's last name)
  241. 1                   <=-  (COM port number - defaults to 1)
  242. 1                   <=-  (Node number - defaults to 1)
  243.  
  244.  
  245. Example Batch File
  246. ==================
  247.  
  248. A sample batch file is included and is similer to the following:
  249.    ECHO OFF
  250.    CD\DOORS\ONLINE          <=- Switch to the door's Directory.
  251.    ONLINE! ONLINE!.CFG      <=- Execute the door program and pass the
  252.                                 configuration filename to the program.
  253.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  254.    BOARD                    <=- Restart BBS.
  255.  
  256.  
  257. This Door is multi-node  compatible so you may run more than 1 node from
  258. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  259. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  260. variables, (q.v.)
  261.  
  262.  
  263. Environment Variables
  264. =====================
  265.  
  266. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  267. variables. Non-PCBoard systems may also use these variables by including
  268. the following in either your BBS batch or AUTOEXEC.BAT
  269.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  270.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  271. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  272. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  273. .CFG file for multi-node operation!
  274.  
  275. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  276. command line.  For example:
  277.  
  278.      ONLINE! ONLINE!.CFG /5
  279. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  280.      ONLINE! ONLINE!.CFG /%IRQ%
  281.  
  282. This tells the program to use IRQ 5 instead of the standard IRQ.
  283.  
  284.  
  285. Sysop Keys
  286. ==========
  287.  
  288. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  289.          written to DOOR.SYS and USERS.SYS
  290. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  291.          and/or written to DOOR.SYS and USERS.SYS
  292. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  293. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  294.          and/or written to DOOR.SYS and USERS.SYS
  295. F8    -  Returns the caller involuntarily to the BBS.
  296. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  297.          and/or written to DOOR.SYS and USERS.SYS
  298. F10   -  Activates SysOp CHAT mode within the DOOR.
  299. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  300. UP    -  Give the caller extra time while in the DOOR.  
  301. DN    -  Subtract time from the caller while in the DOOR. 
  302. HOME  -  HELP key for Status Line options.
  303. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  304. ALT-X -  PCBoard will exit after current caller logs off. Value is
  305.          passed to PCBoard. Not available on non-PCBoard systems.
  306.  
  307.  
  308. SETTING UP FOR DOWNLOADING:
  309. ===========================
  310.  
  311. OnLine allows your users to download files from within the door if you
  312. have the individual download flag set to 'Y'. This section deals with
  313. setting up your NODE#.CFG files for downloading.
  314.  
  315. NOTE: Downloading will not work using CHAIN.TXT on WWIV BBS's!!
  316.  
  317. The example NODE1.CFG files is configured for my BBS system. Here is
  318. what it looks like:
  319.  
  320. Example for NODE1.CFG file:
  321.  
  322. DSZ port COM2 ha both sz
  323. DSZ port COM2 ha both sx
  324. DSZ port COM2 ha both sb
  325.  
  326. Line one is the protocol line for Zmodem, it is set for DSZ (you can
  327. use GSZ if you desire) and for COM port 2. If you are running multiple
  328. nodes, you'll need to setup various NODE#.CFG files, one for each node
  329. of your system. The only item you should have to change is the COM# in
  330. each of the lines. Line 2 and 3 are for Xmodem and Ymodem respectively.
  331.  
  332. If you are using a non-standard COM port or IRQ, please consult your
  333. DSZ or GSZ documentation for other command line options you may need!
  334.  
  335. Let's say you also run a second node and it runs on COM1, you're
  336. NODE2.CFG file would look like this:
  337.  
  338. DSZ port COM1 ha both sz
  339. DSZ port COM1 ha both sx
  340. DSZ port COM1 ha both sb
  341.  
  342. EXAMPLE MENU#.CFG FILE:
  343. =======================
  344.  
  345. "History of OnLine!            ","history.txt",57,"t",11,"y"
  346. "OnLine! LOG File.             ","online.log",300,"t",11,"n"
  347. "OnLine! Documentation.        ","online.doc",431,"t",11,"y"
  348. "EMPTY                         ","EMPTY",0,"E",0,"N"
  349. "EMPTY                         ","EMPTY",0,"E",0,"N"
  350.           |                         |    |  |  |  |
  351.           |           DOS Filename _|    |  |  |  |
  352.           |                              |  |  |  |__ Download Flag
  353.     Small description    # of lines in __|  |  |      y=downloadable
  354.     of the text/ansi      the file          |  |      n=not downloadable
  355.     file.                                   |  |
  356.                                             |  |
  357.                          t=text a=ansi or  _|  |__ Text color to display
  358.                          e=empty                   to user.
  359.  
  360. ** This is not a complete entry, there are 35 more lines.
  361.  
  362. Basically, each MENU#.CFG file contains the information for each
  363. sub-menu in OnLine such as: description of the file, DOS filename, number
  364. of text lines in the file, color to display the text in, what type of
  365. file it is (text or ansi), and if the file is downloadable or not. See
  366. the breakdown listed above. It's much easier using the OLSETUP program
  367. to do this instead of using a text editor to try and modify these
  368. files.
  369.  
  370. The other file is the MENU.CFG file (no number after the MENU). This
  371. file defines your main menu which lists the 40 sub-menu titles. Here's
  372. an example of what it looks like:
  373.  
  374. "Various Documents.            "
  375. "EMPTY                         "
  376. "EMPTY                         "
  377. "EMPTY                         "
  378. "EMPTY                         "
  379.  
  380. ** This is not complete, there are an additional 35 lines.
  381.  
  382.  
  383. SCREEN DESIGN:
  384. =============
  385.  
  386. You may customize the HELLO.SCR and the GOODBYE.SCR screens!
  387.  
  388. First, design your HELLO.SCR for the door! Just work on line 1-22 for
  389. the design. Do not save any of your screens using a 'clear screen' they
  390. should be saved using a 'home cursor', at least if you are using TheDraw.
  391. Also, save the screens using the BLOCK SAVE command, do not simply save
  392. it using the SAVE command. That could cause some problems with the display.
  393. These rules will hold true for both the HELLO.SCR and the GOODBYE.SCR
  394. screens.
  395.  
  396. When block saving your screens, just highlight rows 1 to 22 for the
  397. save.
  398.  
  399. After your done with your HELLO.SCR it's time to make your GOODBYE.SCR!
  400. Do whatever you want here! Just use lines 1-22 for your screen design
  401. following the same rules as above.
  402.  
  403.  
  404. RUNNING LOCALLY:
  405. ===============
  406.  
  407. To run in LOCAL mode simply type ONLINE! LOCAL
  408.  
  409.  
  410. ADDITIONAL HELP:
  411. ===============
  412.  
  413. What if I have an ANSI'ed TEXT file?
  414.  
  415. ---  No problem! In the SETUP program simply identify this file as an
  416.      ANSI screen. You will not be able to SEARCH or anything else. The
  417.      user will be prompted for a "Press ENTER to continue or E to end".
  418.  
  419. When I am viewing a TEXT screen, the screen blanks and gets a little wierd.
  420.  
  421. ---  You must have some CLEAR SCREEN or TOP OF PAGE commands in the
  422.      TEXT file, find them and remove them.
  423.  
  424. I can't seem to get the download option to work!
  425.  
  426. ---  Due to the variety between BBS's packages and COM PORT setups,
  427.      the download option will probably not work on all systems. We
  428.      have modified the download portion of the code to make it easier
  429.      to setup on a single line as well as multi-node systems.
  430.  
  431. If any internal errors do occur, check for a file called DFRAME.ERR
  432. and let me know what the error code says.
  433.  
  434. Several people have been having problems with their Trident SVGA
  435. cards and the ANSI screens not showing up correctly. To fix this,
  436. check you utility disk that came with your Trident card for a program
  437. called TANSI.SYS or something similar. Replace your old ANSI.SYS
  438. with this version of it. This will correct the problems.
  439.  
  440. Several people have had problems running some of the doors under
  441. Livecat. Try copying your user information files to the Dollarmania
  442. sub-directory and then telling Dollarmania to look for them there.
  443. Add something like this to beginning of your door batch file:
  444.  
  445.        COPY C:\WC30\WCWORK\NODE1\DOOR.SYS C:\WC30\DOOR\ONLINE
  446.  
  447. Don't forget to change line one in your ONLINE.CFG file to reflect
  448. the new location of the DOOR.SYS file.
  449.  
  450. Please feel free to contact me if you have any problems at all.
  451.  
  452.  
  453. FUTURE VERSIONS:
  454. ================
  455.  
  456. --->> Your the editor, let me know what you would like to see added!!
  457.  
  458.  
  459. VERSION HISTORY:
  460. ===============
  461. See the HISTORY.TXT file.
  462.  
  463.  
  464. REGISTERING:
  465. ============
  466. That's all there is to it! If you have any problems or questions
  467. please feel free to call the T&J BBS at (717)325-9481 and join the
  468. T&J Software Conference.
  469.  
  470. See the enclosed registration form for ordering!  (REGISTER.TXT)
  471.